home *** CD-ROM | disk | FTP | other *** search
/ PCGUIA 2010 Software/Programs / PCGuia_programas.iso / Software / Utils / VLC Media Player / vlc-1.0.3-win32.exe / sdk / include / vlc / plugins / vlc_variables.h < prev    next >
Encoding:
C/C++ Source or Header  |  2009-10-30  |  20.3 KB  |  671 lines
  1. /*****************************************************************************
  2.  * variables.h: variables handling
  3.  *****************************************************************************
  4.  * Copyright (C) 2002-2004 the VideoLAN team
  5.  * $Id$
  6.  *
  7.  * Authors: Samuel Hocevar <sam@zoy.org>
  8.  *          Gildas Bazin <gbazin@netcourrier.com>
  9.  *
  10.  * This program is free software; you can redistribute it and/or modify
  11.  * it under the terms of the GNU General Public License as published by
  12.  * the Free Software Foundation; either version 2 of the License, or
  13.  * (at your option) any later version.
  14.  *
  15.  * This program is distributed in the hope that it will be useful,
  16.  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  17.  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18.  * GNU General Public License for more details.
  19.  *
  20.  * You should have received a copy of the GNU General Public License
  21.  * along with this program; if not, write to the Free Software
  22.  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
  23.  *****************************************************************************/
  24.  
  25. #ifndef VLC_VARIABLES_H
  26. #define VLC_VARIABLES_H 1
  27.  
  28. /**
  29.  * \file
  30.  * This file defines functions and structures for dynamic variables in vlc
  31.  */
  32.  
  33. /**
  34.  * \defgroup variables Variables
  35.  *
  36.  * Functions for using the object variables in vlc.
  37.  *
  38.  * Vlc have a very powerful "object variable" infrastructure useful
  39.  * for many things.
  40.  *
  41.  * @{
  42.  */
  43.  
  44. /*****************************************************************************
  45.  * Variable types - probably very incomplete
  46.  *****************************************************************************/
  47. #define VLC_VAR_TYPE      0x00ff
  48. #define VLC_VAR_CLASS     0x00f0
  49. #define VLC_VAR_FLAGS     0xff00
  50.  
  51. /** \defgroup var_flags Additive flags
  52.  * These flags are added to the type field of the variable. Most as a result of
  53.  * a __var_Change() call, but some may be added at creation time
  54.  * @{
  55.  */
  56. #define VLC_VAR_HASCHOICE 0x0100
  57. #define VLC_VAR_HASMIN    0x0200
  58. #define VLC_VAR_HASMAX    0x0400
  59. #define VLC_VAR_HASSTEP   0x0800
  60.  
  61. #define VLC_VAR_ISCOMMAND 0x2000
  62.  
  63. /** Creation flag */
  64. /* If the variable is not found on the current module
  65.    search all parents and finally module config until found */
  66. #define VLC_VAR_DOINHERIT 0x8000
  67. /**@}*/
  68.  
  69. /**
  70.  * \defgroup var_action Variable actions
  71.  * These are the different actions that can be used with __var_Change().
  72.  * The parameters given are the meaning of the two last parameters of
  73.  * __var_Change() when this action is being used.
  74.  * @{
  75.  */
  76.  
  77. /**
  78.  * Set the minimum value of this variable
  79.  * \param p_val The new minimum value
  80.  * \param p_val2 Unused
  81.  */
  82. #define VLC_VAR_SETMIN              0x0010
  83. /**
  84.  * Set the maximum value of this variable
  85.  * \param p_val The new maximum value
  86.  * \param p_val2 Unused
  87.  */
  88. #define VLC_VAR_SETMAX              0x0011
  89. #define VLC_VAR_SETSTEP             0x0012
  90.  
  91. /**
  92.  * Set the value of this variable without triggering any callbacks
  93.  * \param p_val The new value
  94.  * \param p_val2 Unused
  95.  */
  96. #define VLC_VAR_SETVALUE            0x0013
  97.  
  98. #define VLC_VAR_SETTEXT             0x0014
  99. #define VLC_VAR_GETTEXT             0x0015
  100.  
  101. #define VLC_VAR_GETMIN              0x0016
  102. #define VLC_VAR_GETMAX              0x0017
  103. #define VLC_VAR_GETSTEP             0x0018
  104.  
  105. #define VLC_VAR_ADDCHOICE           0x0020
  106. #define VLC_VAR_DELCHOICE           0x0021
  107. #define VLC_VAR_CLEARCHOICES        0x0022
  108. #define VLC_VAR_SETDEFAULT          0x0023
  109. #define VLC_VAR_GETCHOICES          0x0024
  110. #define VLC_VAR_FREECHOICES         0x0025
  111. #define VLC_VAR_GETLIST             0x0026
  112. #define VLC_VAR_FREELIST            0x0027
  113. #define VLC_VAR_CHOICESCOUNT        0x0028
  114.  
  115. #define VLC_VAR_INHERITVALUE        0x0030
  116.  
  117. #define VLC_VAR_SETISCOMMAND        0x0040
  118. /**@}*/
  119.  
  120. /*****************************************************************************
  121.  * Prototypes
  122.  *****************************************************************************/
  123. VLC_EXPORT( int, __var_Create, ( vlc_object_t *, const char *, int ) );
  124. VLC_EXPORT( int, __var_Destroy, ( vlc_object_t *, const char * ) );
  125.  
  126. VLC_EXPORT( int, __var_Change, ( vlc_object_t *, const char *, int, vlc_value_t *, vlc_value_t * ) );
  127.  
  128. VLC_EXPORT( int, __var_Type, ( vlc_object_t *, const char * ) LIBVLC_USED );
  129. VLC_EXPORT( int, __var_Set, ( vlc_object_t *, const char *, vlc_value_t ) );
  130. VLC_EXPORT( int, __var_Get, ( vlc_object_t *, const char *, vlc_value_t * ) );
  131. VLC_EXPORT( int, var_SetChecked, ( vlc_object_t *, const char *, int, vlc_value_t ) );
  132. VLC_EXPORT( int, var_GetChecked, ( vlc_object_t *, const char *, int, vlc_value_t * ) );
  133.  
  134. #define var_Command(a,b,c,d,e) __var_Command( VLC_OBJECT( a ), b, c, d, e )
  135. VLC_EXPORT( int, __var_Command, ( vlc_object_t *, const char *, const char *, const char *, char ** ) );
  136.  
  137. /**
  138.  * __var_Create() with automatic casting.
  139.  */
  140. #define var_Create(a,b,c) __var_Create( VLC_OBJECT(a), b, c )
  141. /**
  142.  * __var_Destroy() with automatic casting
  143.  */
  144. #define var_Destroy(a,b) __var_Destroy( VLC_OBJECT(a), b )
  145.  
  146. /**
  147.  * __var_Change() with automatic casting
  148.  */
  149. #define var_Change(a,b,c,d,e) __var_Change( VLC_OBJECT(a), b, c, d, e )
  150.  
  151. /**
  152.  * __var_Type() with automatic casting
  153.  */
  154. #define var_Type(a,b) __var_Type( VLC_OBJECT(a), b )
  155. /**
  156.  * __var_Set() with automatic casting
  157.  */
  158. #define var_Set(a,b,c) __var_Set( VLC_OBJECT(a), b, c )
  159. /**
  160.  * __var_Get() with automatic casting
  161.  */
  162. #define var_Get(a,b,c) __var_Get( VLC_OBJECT(a), b, c )
  163.  
  164. /*****************************************************************************
  165.  * Variable callbacks
  166.  *****************************************************************************
  167.  * int MyCallback( vlc_object_t *p_this,
  168.  *                 char const *psz_variable,
  169.  *                 vlc_value_t oldvalue,
  170.  *                 vlc_value_t newvalue,
  171.  *                 void *p_data);
  172.  *****************************************************************************/
  173. VLC_EXPORT( int, __var_AddCallback, ( vlc_object_t *, const char *, vlc_callback_t, void * ) );
  174. VLC_EXPORT( int, __var_DelCallback, ( vlc_object_t *, const char *, vlc_callback_t, void * ) );
  175. VLC_EXPORT( int, __var_TriggerCallback, ( vlc_object_t *, const char * ) );
  176.  
  177. /**
  178.  * __var_AddCallback() with automatic casting
  179.  */
  180. #define var_AddCallback(a,b,c,d) __var_AddCallback( VLC_OBJECT(a), b, c, d )
  181.  
  182. /**
  183.  * __var_DelCallback() with automatic casting
  184.  */
  185. #define var_DelCallback(a,b,c,d) __var_DelCallback( VLC_OBJECT(a), b, c, d )
  186.  
  187. /**
  188.  * __var_TriggerCallback() with automatic casting
  189.  */
  190. #define var_TriggerCallback(a,b) __var_TriggerCallback( VLC_OBJECT(a), b )
  191.  
  192. /*****************************************************************************
  193.  * helpers functions
  194.  *****************************************************************************/
  195.  
  196. /**
  197.  * Set the value of an integer variable
  198.  *
  199.  * \param p_obj The object that holds the variable
  200.  * \param psz_name The name of the variable
  201.  * \param i The new integer value of this variable
  202.  */
  203. static inline int __var_SetInteger( vlc_object_t *p_obj, const char *psz_name, int i )
  204. {
  205.     vlc_value_t val;
  206.     val.i_int = i;
  207.     return var_SetChecked( p_obj, psz_name, VLC_VAR_INTEGER, val );
  208. }
  209. #define var_SetInteger(a,b,c)   __var_SetInteger( VLC_OBJECT(a),b,c)
  210. /**
  211.  * Set the value of an boolean variable
  212.  *
  213.  * \param p_obj The object that holds the variable
  214.  * \param psz_name The name of the variable
  215.  * \param b The new boolean value of this variable
  216.  */
  217. static inline int __var_SetBool( vlc_object_t *p_obj, const char *psz_name, bool b )
  218. {
  219.     vlc_value_t val;
  220.     val.b_bool = b;
  221.     return var_SetChecked( p_obj, psz_name, VLC_VAR_BOOL, val );
  222. }
  223.  
  224. /**
  225.  * Set the value of a time variable
  226.  *
  227.  * \param p_obj The object that holds the variable
  228.  * \param psz_name The name of the variable
  229.  * \param i The new time value of this variable
  230.  */
  231. static inline int __var_SetTime( vlc_object_t *p_obj, const char *psz_name, int64_t i )
  232. {
  233.     vlc_value_t val;
  234.     val.i_time = i;
  235.     return var_SetChecked( p_obj, psz_name, VLC_VAR_TIME, val );
  236. }
  237.  
  238. /**
  239.  * Set the value of a float variable
  240.  *
  241.  * \param p_obj The object that holds the variable
  242.  * \param psz_name The name of the variable
  243.  * \param f The new float value of this variable
  244.  */
  245. static inline int __var_SetFloat( vlc_object_t *p_obj, const char *psz_name, float f )
  246. {
  247.     vlc_value_t val;
  248.     val.f_float = f;
  249.     return var_SetChecked( p_obj, psz_name, VLC_VAR_FLOAT, val );
  250. }
  251.  
  252. /**
  253.  * Set the value of a string variable
  254.  *
  255.  * \param p_obj The object that holds the variable
  256.  * \param psz_name The name of the variable
  257.  * \param psz_string The new string value of this variable
  258.  */
  259. static inline int __var_SetString( vlc_object_t *p_obj, const char *psz_name, const char *psz_string )
  260. {
  261.     vlc_value_t val;
  262.     val.psz_string = (char *)psz_string;
  263.     return var_SetChecked( p_obj, psz_name, VLC_VAR_STRING, val );
  264. }
  265.  
  266. /**
  267.  * Trigger the callbacks on a void variable
  268.  *
  269.  * \param p_obj The object that holds the variable
  270.  * \param psz_name The name of the variable
  271.  */
  272. static inline int __var_SetVoid( vlc_object_t *p_obj, const char *psz_name )
  273. {
  274.     vlc_value_t val;
  275.     val.b_bool = true;
  276.     return var_SetChecked( p_obj, psz_name, VLC_VAR_VOID, val );
  277. }
  278. #define var_SetVoid(a,b)        __var_SetVoid( VLC_OBJECT(a),b)
  279.  
  280. /**
  281.  * Set the value of a pointer variable
  282.  *
  283.  * \param p_obj The object that holds the variable
  284.  * \param psz_name The name of the variable
  285.  * \param ptr The new pointer value of this variable
  286.  */
  287. static inline
  288. int var_SetAddress( vlc_object_t *p_obj, const char *psz_name, void *ptr )
  289. {
  290.     vlc_value_t val;
  291.     val.p_address = ptr;
  292.     return var_SetChecked( p_obj, psz_name, VLC_VAR_ADDRESS, val );
  293. }
  294. #define var_SetAddress(o, n, p) var_SetAddress(VLC_OBJECT(o), n, p)
  295.  
  296.  
  297. /**
  298.  * __var_SetBool() with automatic casting
  299.  */
  300. #define var_SetBool(a,b,c)   __var_SetBool( VLC_OBJECT(a),b,c)
  301.  
  302. /**
  303.  * __var_SetTime() with automatic casting
  304.  */
  305. #define var_SetTime(a,b,c)      __var_SetTime( VLC_OBJECT(a),b,c)
  306. /**
  307.  * __var_SetFloat() with automatic casting
  308.  */
  309. #define var_SetFloat(a,b,c)     __var_SetFloat( VLC_OBJECT(a),b,c)
  310. /**
  311.  * __var_SetString() with automatic casting
  312.  */
  313. #define var_SetString(a,b,c)     __var_SetString( VLC_OBJECT(a),b,c)
  314.  
  315. /**
  316.  * Get an integer value
  317. *
  318.  * \param p_obj The object that holds the variable
  319.  * \param psz_name The name of the variable
  320.  */
  321. LIBVLC_USED
  322. static inline int __var_GetInteger( vlc_object_t *p_obj, const char *psz_name )
  323. {
  324.     vlc_value_t val;
  325.     if( !var_GetChecked( p_obj, psz_name, VLC_VAR_INTEGER, &val ) )
  326.         return val.i_int;
  327.     else
  328.         return 0;
  329. }
  330.  
  331. /**
  332.  * Get a boolean value
  333.  *
  334.  * \param p_obj The object that holds the variable
  335.  * \param psz_name The name of the variable
  336.  */
  337. LIBVLC_USED
  338. static inline bool __var_GetBool( vlc_object_t *p_obj, const char *psz_name )
  339. {
  340.     vlc_value_t val; val.b_bool = false;
  341.  
  342.     if( !var_GetChecked( p_obj, psz_name, VLC_VAR_BOOL, &val ) )
  343.         return val.b_bool;
  344.     else
  345.         return false;
  346. }
  347.  
  348. /**
  349.  * Get a time value
  350.  *
  351.  * \param p_obj The object that holds the variable
  352.  * \param psz_name The name of the variable
  353.  */
  354. LIBVLC_USED
  355. static inline int64_t __var_GetTime( vlc_object_t *p_obj, const char *psz_name )
  356. {
  357.     vlc_value_t val; val.i_time = 0L;
  358.     if( !var_GetChecked( p_obj, psz_name, VLC_VAR_TIME, &val ) )
  359.         return val.i_time;
  360.     else
  361.         return 0;
  362. }
  363.  
  364. /**
  365.  * Get a float value
  366.  *
  367.  * \param p_obj The object that holds the variable
  368.  * \param psz_name The name of the variable
  369.  */
  370. LIBVLC_USED
  371. static inline float __var_GetFloat( vlc_object_t *p_obj, const char *psz_name )
  372. {
  373.     vlc_value_t val; val.f_float = 0.0;
  374.     if( !var_GetChecked( p_obj, psz_name, VLC_VAR_FLOAT, &val ) )
  375.         return val.f_float;
  376.     else
  377.         return 0.0;
  378. }
  379.  
  380. /**
  381.  * Get a string value
  382.  *
  383.  * \param p_obj The object that holds the variable
  384.  * \param psz_name The name of the variable
  385.  */
  386. LIBVLC_USED
  387. static inline char *__var_GetString( vlc_object_t *p_obj, const char *psz_name )
  388. {
  389.     vlc_value_t val; val.psz_string = NULL;
  390.     if( var_GetChecked( p_obj, psz_name, VLC_VAR_STRING, &val ) )
  391.         return NULL;
  392.     else
  393.         return val.psz_string;
  394. }
  395.  
  396. LIBVLC_USED
  397. static inline char *__var_GetNonEmptyString( vlc_object_t *p_obj, const char *psz_name )
  398. {
  399.     vlc_value_t val;
  400.     if( var_GetChecked( p_obj, psz_name, VLC_VAR_STRING, &val ) )
  401.         return NULL;
  402.     if( val.psz_string && *val.psz_string )
  403.         return val.psz_string;
  404.     free( val.psz_string );
  405.     return NULL;
  406. }
  407.  
  408.  
  409. /**
  410.  * __var_GetInteger() with automatic casting
  411.  */
  412. #define var_GetInteger(a,b)   __var_GetInteger( VLC_OBJECT(a),b)
  413. /**
  414.  * __var_GetBool() with automatic casting
  415.  */
  416. #define var_GetBool(a,b)   __var_GetBool( VLC_OBJECT(a),b)
  417. /**
  418.  * __var_GetTime() with automatic casting
  419.  */
  420. #define var_GetTime(a,b)   __var_GetTime( VLC_OBJECT(a),b)
  421. /**
  422.  * __var_GetFloat() with automatic casting
  423.  */
  424. #define var_GetFloat(a,b)   __var_GetFloat( VLC_OBJECT(a),b)
  425. /**
  426.  * __var_GetString() with automatic casting
  427.  */
  428. #define var_GetString(a,b)   __var_GetString( VLC_OBJECT(a),b)
  429. #define var_GetNonEmptyString(a,b)   __var_GetNonEmptyString( VLC_OBJECT(a),b)
  430.  
  431.  
  432.  
  433. /**
  434.  * Increment an integer variable
  435.  * \param p_obj the object that holds the variable
  436.  * \param psz_name the name of the variable
  437.  */
  438. static inline void __var_IncInteger( vlc_object_t *p_obj, const char *psz_name )
  439. {
  440.     int i_val = __var_GetInteger( p_obj, psz_name );
  441.     __var_SetInteger( p_obj, psz_name, ++i_val );
  442. }
  443. #define var_IncInteger(a,b) __var_IncInteger( VLC_OBJECT(a), b )
  444.  
  445. /**
  446.  * Decrement an integer variable
  447.  * \param p_obj the object that holds the variable
  448.  * \param psz_name the name of the variable
  449.  */
  450. static inline void __var_DecInteger( vlc_object_t *p_obj, const char *psz_name )
  451. {
  452.     int i_val = __var_GetInteger( p_obj, psz_name );
  453.     __var_SetInteger( p_obj, psz_name, --i_val );
  454. }
  455. #define var_DecInteger(a,b) __var_DecInteger( VLC_OBJECT(a), b )
  456.  
  457. /**
  458.  * Create a integer variable with inherit and get its value.
  459.  *
  460.  * \param p_obj The object that holds the variable
  461.  * \param psz_name The name of the variable
  462.  */
  463. LIBVLC_USED
  464. static inline int __var_CreateGetInteger( vlc_object_t *p_obj, const char *psz_name )
  465. {
  466.     __var_Create( p_obj, psz_name, VLC_VAR_INTEGER | VLC_VAR_DOINHERIT );
  467.     return __var_GetInteger( p_obj, psz_name );
  468. }
  469.  
  470. /**
  471.  * Create a boolean variable with inherit and get its value.
  472.  *
  473.  * \param p_obj The object that holds the variable
  474.  * \param psz_name The name of the variable
  475.  */
  476. LIBVLC_USED
  477. static inline bool __var_CreateGetBool( vlc_object_t *p_obj, const char *psz_name )
  478. {
  479.     __var_Create( p_obj, psz_name, VLC_VAR_BOOL | VLC_VAR_DOINHERIT );
  480.     return __var_GetBool( p_obj, psz_name );
  481. }
  482.  
  483. /**
  484.  * Create a time variable with inherit and get its value.
  485.  *
  486.  * \param p_obj The object that holds the variable
  487.  * \param psz_name The name of the variable
  488.  */
  489. LIBVLC_USED
  490. static inline int64_t __var_CreateGetTime( vlc_object_t *p_obj, const char *psz_name )
  491. {
  492.     __var_Create( p_obj, psz_name, VLC_VAR_TIME | VLC_VAR_DOINHERIT );
  493.     return __var_GetTime( p_obj, psz_name );
  494. }
  495.  
  496. /**
  497.  * Create a float variable with inherit and get its value.
  498.  *
  499.  * \param p_obj The object that holds the variable
  500.  * \param psz_name The name of the variable
  501.  */
  502. LIBVLC_USED
  503. static inline float __var_CreateGetFloat( vlc_object_t *p_obj, const char *psz_name )
  504. {
  505.     __var_Create( p_obj, psz_name, VLC_VAR_FLOAT | VLC_VAR_DOINHERIT );
  506.     return __var_GetFloat( p_obj, psz_name );
  507. }
  508.  
  509. /**
  510.  * Create a string variable with inherit and get its value.
  511.  *
  512.  * \param p_obj The object that holds the variable
  513.  * \param psz_name The name of the variable
  514.  */
  515. LIBVLC_USED
  516. static inline char *__var_CreateGetString( vlc_object_t *p_obj,
  517.                                            const char *psz_name )
  518. {
  519.     __var_Create( p_obj, psz_name, VLC_VAR_STRING | VLC_VAR_DOINHERIT );
  520.     return __var_GetString( p_obj, psz_name );
  521. }
  522.  
  523. LIBVLC_USED
  524. static inline char *__var_CreateGetNonEmptyString( vlc_object_t *p_obj,
  525.                                                    const char *psz_name )
  526. {
  527.     __var_Create( p_obj, psz_name, VLC_VAR_STRING | VLC_VAR_DOINHERIT );
  528.     return __var_GetNonEmptyString( p_obj, psz_name );
  529. }
  530.  
  531. /**
  532.  * __var_CreateGetInteger() with automatic casting
  533.  */
  534. #define var_CreateGetInteger(a,b)   __var_CreateGetInteger( VLC_OBJECT(a),b)
  535. /**
  536.  * __var_CreateGetBool() with automatic casting
  537.  */
  538. #define var_CreateGetBool(a,b)   __var_CreateGetBool( VLC_OBJECT(a),b)
  539. /**
  540.  * __var_CreateGetTime() with automatic casting
  541.  */
  542. #define var_CreateGetTime(a,b)   __var_CreateGetTime( VLC_OBJECT(a),b)
  543. /**
  544.  * __var_CreateGetFloat() with automatic casting
  545.  */
  546. #define var_CreateGetFloat(a,b)   __var_CreateGetFloat( VLC_OBJECT(a),b)
  547. /**
  548.  * __var_CreateGetString() with automatic casting
  549.  */
  550. #define var_CreateGetString(a,b)   __var_CreateGetString( VLC_OBJECT(a),b)
  551. #define var_CreateGetNonEmptyString(a,b)   __var_CreateGetNonEmptyString( VLC_OBJECT(a),b)
  552.  
  553. /**
  554.  * Create a integer command variable with inherit and get its value.
  555.  *
  556.  * \param p_obj The object that holds the variable
  557.  * \param psz_name The name of the variable
  558.  */
  559. LIBVLC_USED
  560. static inline int __var_CreateGetIntegerCommand( vlc_object_t *p_obj, const char *psz_name )
  561. {
  562.     __var_Create( p_obj, psz_name, VLC_VAR_INTEGER | VLC_VAR_DOINHERIT
  563.                                    | VLC_VAR_ISCOMMAND );
  564.     return __var_GetInteger( p_obj, psz_name );
  565. }
  566.  
  567. /**
  568.  * Create a boolean command variable with inherit and get its value.
  569.  *
  570.  * \param p_obj The object that holds the variable
  571.  * \param psz_name The name of the variable
  572.  */
  573. LIBVLC_USED
  574. static inline bool __var_CreateGetBoolCommand( vlc_object_t *p_obj, const char *psz_name )
  575. {
  576.     __var_Create( p_obj, psz_name, VLC_VAR_BOOL | VLC_VAR_DOINHERIT
  577.                                    | VLC_VAR_ISCOMMAND );
  578.     return __var_GetBool( p_obj, psz_name );
  579. }
  580.  
  581. /**
  582.  * Create a time command variable with inherit and get its value.
  583.  *
  584.  * \param p_obj The object that holds the variable
  585.  * \param psz_name The name of the variable
  586.  */
  587. LIBVLC_USED
  588. static inline int64_t __var_CreateGetTimeCommand( vlc_object_t *p_obj, const char *psz_name )
  589. {
  590.     __var_Create( p_obj, psz_name, VLC_VAR_TIME | VLC_VAR_DOINHERIT
  591.                                    | VLC_VAR_ISCOMMAND );
  592.     return __var_GetTime( p_obj, psz_name );
  593. }
  594.  
  595. /**
  596.  * Create a float command variable with inherit and get its value.
  597.  *
  598.  * \param p_obj The object that holds the variable
  599.  * \param psz_name The name of the variable
  600.  */
  601. LIBVLC_USED
  602. static inline float __var_CreateGetFloatCommand( vlc_object_t *p_obj, const char *psz_name )
  603. {
  604.     __var_Create( p_obj, psz_name, VLC_VAR_FLOAT | VLC_VAR_DOINHERIT
  605.                                    | VLC_VAR_ISCOMMAND );
  606.     return __var_GetFloat( p_obj, psz_name );
  607. }
  608.  
  609. /**
  610.  * Create a string command variable with inherit and get its value.
  611.  *
  612.  * \param p_obj The object that holds the variable
  613.  * \param psz_name The name of the variable
  614.  */
  615. LIBVLC_USED
  616. static inline char *__var_CreateGetStringCommand( vlc_object_t *p_obj,
  617.                                            const char *psz_name )
  618. {
  619.     __var_Create( p_obj, psz_name, VLC_VAR_STRING | VLC_VAR_DOINHERIT
  620.                                    | VLC_VAR_ISCOMMAND );
  621.     return __var_GetString( p_obj, psz_name );
  622. }
  623.  
  624. LIBVLC_USED
  625. static inline char *__var_CreateGetNonEmptyStringCommand( vlc_object_t *p_obj,
  626.                                                    const char *psz_name )
  627. {
  628.     __var_Create( p_obj, psz_name, VLC_VAR_STRING | VLC_VAR_DOINHERIT
  629.                                    | VLC_VAR_ISCOMMAND );
  630.     return __var_GetNonEmptyString( p_obj, psz_name );
  631. }
  632.  
  633. /**
  634.  * __var_CreateGetInteger() with automatic casting
  635.  */
  636. #define var_CreateGetIntegerCommand(a,b)   __var_CreateGetIntegerCommand( VLC_OBJECT(a),b)
  637. /**
  638.  * __var_CreateGetBoolCommand() with automatic casting
  639.  */
  640. #define var_CreateGetBoolCommand(a,b)   __var_CreateGetBoolCommand( VLC_OBJECT(a),b)
  641. /**
  642.  * __var_CreateGetTimeCommand() with automatic casting
  643.  */
  644. #define var_CreateGetTimeCommand(a,b)   __var_CreateGetTimeCommand( VLC_OBJECT(a),b)
  645. /**
  646.  * __var_CreateGetFloat() with automatic casting
  647.  */
  648. #define var_CreateGetFloatCommand(a,b)   __var_CreateGetFloatCommand( VLC_OBJECT(a),b)
  649. /**
  650.  * __var_CreateGetStringCommand() with automatic casting
  651.  */
  652. #define var_CreateGetStringCommand(a,b)   __var_CreateGetStringCommand( VLC_OBJECT(a),b)
  653. #define var_CreateGetNonEmptyStringCommand(a,b)   __var_CreateGetNonEmptyStringCommand( VLC_OBJECT(a),b)
  654.  
  655. static inline int __var_CountChoices( vlc_object_t *p_obj, const char *psz_name )
  656. {
  657.     vlc_value_t count;
  658.     if( __var_Change( p_obj, psz_name, VLC_VAR_CHOICESCOUNT, &count, NULL ) )
  659.         return 0;
  660.     return count.i_int;
  661. }
  662. /**
  663.  * __var_CountChoices() with automatic casting
  664.  */
  665. #define var_CountChoices(a,b) __var_CountChoices( VLC_OBJECT(a),b)
  666.  
  667. /**
  668.  * @}
  669.  */
  670. #endif /*  _VLC_VARIABLES_H */
  671.